home *** CD-ROM | disk | FTP | other *** search
/ Ultimedia 1 / Ultimedia 1.iso / tools / sonstiges / easysound / easysound.doc < prev    next >
Encoding:
Text File  |  1994-08-10  |  4.2 KB  |  132 lines
  1. TABLE OF CONTENTS
  2.  
  3. EasySound/GetClockSpeed
  4. EasySound/LoadIff
  5. EasySound/PlayIff
  6. EasySound/RemoveIff
  7. EasySound/StopIff
  8. EasySound/GetClockSpeed                               EasySound/GetClockSpeed
  9.  
  10.    NAME
  11.        GetClockSpeed -- Determine the clock speed for PAL / NTSC
  12.  
  13.    SYNOPSIS
  14.        clock = GetClockSpeed()
  15.  
  16.        LONG GetClockSpeed( void )
  17.  
  18.    FUNCTION
  19.        This function returns the clockspeed for e.g samples depending
  20.        on the system you use (NTSC or PAL).
  21.  
  22.    SEE ALSO
  23.        RKRM, Guru Book page 62/63
  24. EasySound/LoadIff                                           EasySound/LoadIff
  25.  
  26.    NAME
  27.        LoadIff -- Load an external sample in the chip memory
  28.  
  29.    SYNOPSIS
  30.        info = LoadIff(filename)
  31.  
  32.        struct SoundInfo *LoadIff(STRPTR)
  33.  
  34.    FUNCTION
  35.        Loads an external 8svx sample in chip memory and returns a pointer
  36.        to the SoundInfo structure or NULL if the whole thing failed.
  37.  
  38.    INPUTS
  39.        filename    - Name of the file, eventually with path.
  40.  
  41.    SEE ALSO
  42.        PlayIff, StopIff, LoadIff
  43. EasySound/PlayIff                                           EasySound/PlayIff
  44.  
  45.    NAME
  46.        PlayIff -- Play an IFF sample
  47.  
  48.    SYNOPSIS
  49.        success = PlayIff(info, vol, chan, prio, drate, times, start,
  50.                          time, wait)
  51.        BOOL PlayIff
  52.            (struct SoundInfo *, UWORD, UBYTE, BYTE, WORD, UWORD, ULONG,
  53.             ULONG, BOOL)
  54.  
  55.    FUNCTION
  56.        Plays an IFF sample. The sample has to be converted to an include
  57.        file with the aid of the external program 'iff2src'. The resulting 
  58.        sound data has to be placed in chip memory using e.g. the __chip 
  59.        keyword.
  60.  
  61.    INPUTS
  62.        info        - A (struct SoundInfo *) pointer to the structure.
  63.        vol         - The volume of the sound (between 0 and 64).
  64.        chan        - The channel on which the sample will be played, can
  65.                      be either left or right ;-) . You may use the magic
  66.                      cookies L0, L1, R0, R1.
  67.        prio        - State a priority for the sample. (may be something
  68.                      between -127 and 128.
  69.        drate       - The sample rate is already stored in the SoundInfo
  70.                      structure. If you don't want to change the rate,
  71.                      leave this value 0.
  72.        times       - How many times do you want this sound to be played.
  73.                      If you set this value to 0 the sound will be played
  74.                      nonstop. (You may stop it with StopIff)
  75.        start       - Where do you want to start the sample, leave this
  76.                      value to 0 if you want to start at the beginning.
  77.        time        - How long do you want to play this sound, leave this
  78.                      value to 0 if you want to play the whole sample.
  79.        wait        - If you set this value to TRUE your program will wait
  80.                      until the Sample is played. If it's set to FALSE your
  81.                      program will continue to run while the sample is
  82.                      played.
  83.  
  84.    RESULT
  85.        success     - Returns TRUE if the sound was played with success,
  86.                      otherwise the function will return FALSE.
  87.  
  88.    EXAMPLE
  89.        PlayIff(&splat_data,64,L0,-35,0,1,0,0,0);
  90.  
  91.    SEE ALSO
  92.        StopIff, RemoveIff, LoadIff
  93. EasySound/RemoveIff                                       EasySound/RemoveIff
  94.  
  95.    NAME
  96.        RemoveIff -- Remove a previous loaded Sound.
  97.  
  98.    SYNOPSIS
  99.        RemoveIff(info)
  100.  
  101.        void RemoveIff (struct SoundInfo *)
  102.  
  103.    FUNCTION
  104.        Will flush a loaded sample and free the memory.
  105.  
  106.    INPUTS
  107.        info        - Pointer to the SoundInfo structure
  108.  
  109.    SEE ALSO
  110.        PlayIff, StopIff, LoadIff
  111. EasySound/StopIff                                           EasySound/StopIff
  112.  
  113.    NAME
  114.        StopIff -- Stop an IFF sample
  115.  
  116.    SYNOPSIS
  117.        StopIff(chan)
  118.  
  119.        void StopIff (UBYTE)
  120.  
  121.    FUNCTION
  122.        Will stop the sound on the specified audio channel. It'll close the
  123.        the devices and ports and free the allocated memory. If you call 
  124.        this function without any sound being played it'll simply return.
  125.  
  126.    INPUTS
  127.        chan        - The channel that should be stopped. You may use the
  128.                      magic cookies L0,L1,R0,R1 for this task.
  129.  
  130.    SEE ALSO
  131.        PlayIff, RemoveIff, LoadIff
  132.